Documents

Delete Disputes ID Documents Document ID

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Delete Disputes ID Documents Document ID

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X DELETE\
-H "Accept: application/json"\
"https://api.omise.co/disputes/{id}/documents/{document_id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentsApi;

import java.io.File;
import java.util.*;

public class DocumentsApiExample {

    public static void main(String[] args) {
        
        DocumentsApi apiInstance = new DocumentsApi();
        String id = id_example; // String | 
        String documentId = documentId_example; // String | 
        try {
            document result = apiInstance.disputesIdDocumentsDocumentIdDelete(id, documentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#disputesIdDocumentsDocumentIdDelete");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DocumentsApi;

public class DocumentsApiExample {

    public static void main(String[] args) {
        DocumentsApi apiInstance = new DocumentsApi();
        String id = id_example; // String | 
        String documentId = documentId_example; // String | 
        try {
            document result = apiInstance.disputesIdDocumentsDocumentIdDelete(id, documentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#disputesIdDocumentsDocumentIdDelete");
            e.printStackTrace();
        }
    }
}

String *id = id_example; // 
String *documentId = documentId_example; // 

DocumentsApi *apiInstance = [[DocumentsApi alloc] init];

[apiInstance disputesIdDocumentsDocumentIdDeleteWith:id
    documentId:documentId
              completionHandler: ^(document output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.DocumentsApi()
var id = id_example; // {{String}} 
var documentId = documentId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disputesIdDocumentsDocumentIdDelete(id, documentId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disputesIdDocumentsDocumentIdDeleteExample
    {
        public void main()
        {

            var apiInstance = new DocumentsApi();
            var id = id_example;  // String | 
            var documentId = documentId_example;  // String | 

            try
            {
                document result = apiInstance.disputesIdDocumentsDocumentIdDelete(id, documentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentsApi.disputesIdDocumentsDocumentIdDelete: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentsApi();
$id = id_example; // String | 
$documentId = documentId_example; // String | 

try {
    $result = $api_instance->disputesIdDocumentsDocumentIdDelete($id, $documentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->disputesIdDocumentsDocumentIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentsApi;

my $api_instance = WWW::SwaggerClient::DocumentsApi->new();
my $id = id_example; # String | 
my $documentId = documentId_example; # String | 

eval { 
    my $result = $api_instance->disputesIdDocumentsDocumentIdDelete(id => $id, documentId => $documentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentsApi->disputesIdDocumentsDocumentIdDelete: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentsApi()
id = id_example # String | 
documentId = documentId_example # String | 

try: 
    api_response = api_instance.disputes_id_documents_document_id_delete(id, documentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->disputesIdDocumentsDocumentIdDelete: %s\n" % e)

Parameters

Name	Description
id*	String Required
document_id*	String Required

Retrieve Disputes ID Documents Document ID

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Disputes ID Documents Document ID

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/disputes/{id}/documents/{document_id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentsApi;

import java.io.File;
import java.util.*;

public class DocumentsApiExample {

    public static void main(String[] args) {
        
        DocumentsApi apiInstance = new DocumentsApi();
        String id = id_example; // String | 
        String documentId = documentId_example; // String | 
        try {
            document result = apiInstance.disputesIdDocumentsDocumentIdGet(id, documentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#disputesIdDocumentsDocumentIdGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DocumentsApi;

public class DocumentsApiExample {

    public static void main(String[] args) {
        DocumentsApi apiInstance = new DocumentsApi();
        String id = id_example; // String | 
        String documentId = documentId_example; // String | 
        try {
            document result = apiInstance.disputesIdDocumentsDocumentIdGet(id, documentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#disputesIdDocumentsDocumentIdGet");
            e.printStackTrace();
        }
    }
}

String *id = id_example; // 
String *documentId = documentId_example; // 

DocumentsApi *apiInstance = [[DocumentsApi alloc] init];

[apiInstance disputesIdDocumentsDocumentIdGetWith:id
    documentId:documentId
              completionHandler: ^(document output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.DocumentsApi()
var id = id_example; // {{String}} 
var documentId = documentId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disputesIdDocumentsDocumentIdGet(id, documentId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disputesIdDocumentsDocumentIdGetExample
    {
        public void main()
        {

            var apiInstance = new DocumentsApi();
            var id = id_example;  // String | 
            var documentId = documentId_example;  // String | 

            try
            {
                document result = apiInstance.disputesIdDocumentsDocumentIdGet(id, documentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentsApi.disputesIdDocumentsDocumentIdGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentsApi();
$id = id_example; // String | 
$documentId = documentId_example; // String | 

try {
    $result = $api_instance->disputesIdDocumentsDocumentIdGet($id, $documentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->disputesIdDocumentsDocumentIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentsApi;

my $api_instance = WWW::SwaggerClient::DocumentsApi->new();
my $id = id_example; # String | 
my $documentId = documentId_example; # String | 

eval { 
    my $result = $api_instance->disputesIdDocumentsDocumentIdGet(id => $id, documentId => $documentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentsApi->disputesIdDocumentsDocumentIdGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentsApi()
id = id_example # String | 
documentId = documentId_example # String | 

try: 
    api_response = api_instance.disputes_id_documents_document_id_get(id, documentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->disputesIdDocumentsDocumentIdGet: %s\n" % e)

Parameters

Name	Description
id*	String Required
document_id*	String Required

Retrieve Disputes ID Documents

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Disputes ID Documents

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/disputes/{id}/documents?from=&to=&offset=&limit=&order="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentsApi;

import java.io.File;
import java.util.*;

public class DocumentsApiExample {

    public static void main(String[] args) {
        
        DocumentsApi apiInstance = new DocumentsApi();
        String id = id_example; // String | 
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | 
        Integer limit = 56; // Integer | 
        String order = order_example; // String | 
        try {
            list result = apiInstance.disputesIdDocumentsGet(id, from, to, offset, limit, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#disputesIdDocumentsGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DocumentsApi;

public class DocumentsApiExample {

    public static void main(String[] args) {
        DocumentsApi apiInstance = new DocumentsApi();
        String id = id_example; // String | 
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | 
        Integer limit = 56; // Integer | 
        String order = order_example; // String | 
        try {
            list result = apiInstance.disputesIdDocumentsGet(id, from, to, offset, limit, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#disputesIdDocumentsGet");
            e.printStackTrace();
        }
    }
}

String *id = id_example; // 
Date *from = 2013-10-20T19:20:30+01:00; //  (optional) (default to 1970-01-01T00:00Z)
Date *to = 2013-10-20T19:20:30+01:00; //  (optional)
Integer *offset = 56; //  (optional) (default to 0)
Integer *limit = 56; //  (optional) (default to 20)
String *order = order_example; //  (optional) (default to chronological)

DocumentsApi *apiInstance = [[DocumentsApi alloc] init];

[apiInstance disputesIdDocumentsGetWith:id
    from:from
    to:to
    offset:offset
    limit:limit
    order:order
              completionHandler: ^(list output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.DocumentsApi()
var id = id_example; // {{String}} 
var opts = { 
  'from': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'to': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'offset': 56, // {{Integer}} 
  'limit': 56, // {{Integer}} 
  'order': order_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disputesIdDocumentsGet(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disputesIdDocumentsGetExample
    {
        public void main()
        {

            var apiInstance = new DocumentsApi();
            var id = id_example;  // String | 
            var from = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to 1970-01-01T00:00Z)
            var to = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var limit = 56;  // Integer |  (optional)  (default to 20)
            var order = order_example;  // String |  (optional)  (default to chronological)

            try
            {
                list result = apiInstance.disputesIdDocumentsGet(id, from, to, offset, limit, order);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentsApi.disputesIdDocumentsGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentsApi();
$id = id_example; // String | 
$from = 2013-10-20T19:20:30+01:00; // Date | 
$to = 2013-10-20T19:20:30+01:00; // Date | 
$offset = 56; // Integer | 
$limit = 56; // Integer | 
$order = order_example; // String | 

try {
    $result = $api_instance->disputesIdDocumentsGet($id, $from, $to, $offset, $limit, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->disputesIdDocumentsGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentsApi;

my $api_instance = WWW::SwaggerClient::DocumentsApi->new();
my $id = id_example; # String | 
my $from = 2013-10-20T19:20:30+01:00; # Date | 
my $to = 2013-10-20T19:20:30+01:00; # Date | 
my $offset = 56; # Integer | 
my $limit = 56; # Integer | 
my $order = order_example; # String | 

eval { 
    my $result = $api_instance->disputesIdDocumentsGet(id => $id, from => $from, to => $to, offset => $offset, limit => $limit, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentsApi->disputesIdDocumentsGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentsApi()
id = id_example # String | 
from = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to 1970-01-01T00:00Z)
to = 2013-10-20T19:20:30+01:00 # Date |  (optional)
offset = 56 # Integer |  (optional) (default to 0)
limit = 56 # Integer |  (optional) (default to 20)
order = order_example # String |  (optional) (default to chronological)

try: 
    api_response = api_instance.disputes_id_documents_get(id, from=from, to=to, offset=offset, limit=limit, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->disputesIdDocumentsGet: %s\n" % e)

Parameters

Name	Description
id*	String Required

Parameters

Name	Description
from	Date (date-time)
to	Date (date-time)
offset	Integer
limit	Integer
order	String

Create Disputes ID Documents

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Create Disputes ID Documents

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/x-www-form-urlencoded"\
"https://api.omise.co/disputes/{id}/documents"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentsApi;

import java.io.File;
import java.util.*;

public class DocumentsApiExample {

    public static void main(String[] args) {
        
        DocumentsApi apiInstance = new DocumentsApi();
        String id = id_example; // String | 
        String file = file_example; // String | 
        String kind = kind_example; // String | 
        try {
            document result = apiInstance.disputesIdDocumentsPost(id, file, kind);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#disputesIdDocumentsPost");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DocumentsApi;

public class DocumentsApiExample {

    public static void main(String[] args) {
        DocumentsApi apiInstance = new DocumentsApi();
        String id = id_example; // String | 
        String file = file_example; // String | 
        String kind = kind_example; // String | 
        try {
            document result = apiInstance.disputesIdDocumentsPost(id, file, kind);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#disputesIdDocumentsPost");
            e.printStackTrace();
        }
    }
}

String *id = id_example; // 
String *file = file_example; //  (optional)
String *kind = kind_example; //  (optional)

DocumentsApi *apiInstance = [[DocumentsApi alloc] init];

[apiInstance disputesIdDocumentsPostWith:id
    file:file
    kind:kind
              completionHandler: ^(document output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.DocumentsApi()
var id = id_example; // {{String}} 
var opts = { 
  'file': file_example // {{String}} 
  'kind': kind_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disputesIdDocumentsPost(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disputesIdDocumentsPostExample
    {
        public void main()
        {

            var apiInstance = new DocumentsApi();
            var id = id_example;  // String | 
            var file = file_example;  // String |  (optional) 
            var kind = kind_example;  // String |  (optional) 

            try
            {
                document result = apiInstance.disputesIdDocumentsPost(id, file, kind);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentsApi.disputesIdDocumentsPost: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentsApi();
$id = id_example; // String | 
$file = file_example; // String | 
$kind = kind_example; // String | 

try {
    $result = $api_instance->disputesIdDocumentsPost($id, $file, $kind);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->disputesIdDocumentsPost: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentsApi;

my $api_instance = WWW::SwaggerClient::DocumentsApi->new();
my $id = id_example; # String | 
my $file = file_example; # String | 
my $kind = kind_example; # String | 

eval { 
    my $result = $api_instance->disputesIdDocumentsPost(id => $id, file => $file, kind => $kind);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentsApi->disputesIdDocumentsPost: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentsApi()
id = id_example # String | 
file = file_example # String |  (optional)
kind = kind_example # String |  (optional)

try: 
    api_response = api_instance.disputes_id_documents_post(id, file=file, kind=kind)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->disputesIdDocumentsPost: %s\n" % e)

Parameters

Name	Description
id*	String Required

Parameters

Name	Description
file	String
kind	String

Responses

Status: 200

 {
  "object": {
    "pattern": "document",
    "type": "string",
    "default": "document"
  },
  "livemode": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "id": {
    "type": "string"
  },
  "deleted": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "filename": {
    "type": "string"
  },
  "location": {
    "type": "string"
  },
  "kind": {
    "type": "string"
  },
  "download_uri": {
    "type": "string",
    "format": "uri"
  },
  "created_at": {
    "type": "string",
    "format": "date-time"
  }
}